<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class uhu_loadable</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class uhu_loadable</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The basic class used to define applications, components and libraries used within UHU</p>
		<p class="notes">
			Located in <a class="field" href="_uhu---loadables.php.html">/uhu/loadables.php</a> (line <span class="field">43</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../UHU_Loadable/UHU_Components/uhu_component.html">uhu_component</a></td>
					<td>
											
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../UHU_Loadable/UHU_Apps/uhu_application.html">uhu_application</a></td>
					<td>
											
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../UHU_Loadable/UHU_Libs/uhu_lib.html">uhu_lib</a></td>
					<td>
											
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																				<div class="var-title">
					static <span class="var-type">array</span>
					<a href="#$components" title="details" class="var-name">$components</a>
				</div>
																																																												<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$class_name" title="details" class="var-name">$class_name</a>
				</div>
																								<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$interface" title="details" class="var-name">$interface</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$label" title="details" class="var-name">$label</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$loaded" title="details" class="var-name">$loaded</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$loading" title="details" class="var-name">$loading</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$path" title="details" class="var-name">$path</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">uhu_loadable</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$path_to_file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$class_name</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$interface</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#class_name" title="details" class="method-name">class_name</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#label" title="details" class="method-name">label</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#load" title="details" class="method-name">load</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#load_cond" title="details" class="method-name">load_cond</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#path" title="details" class="method-name">path</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$components" id="$components"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>
			<span class="var-name">$components</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">48</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> the array storing the loadable definitions in memory.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$class_name" id="$class_name"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$class_name</span>
						(line <span class="line-number">60</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> the name of a class that will be found in the loadable</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload">uhu_loadable::load()</a></li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodclass_name">uhu_loadable::class_name()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$interface" id="$interface"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$interface</span>
						(line <span class="line-number">64</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> TRUE if the loadable refers to an interface, FALSE if if the loadable refers to a class or abstract class</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload_cond">uhu_loadable::load_cond()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$label" id="$label"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$label</span>
						(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> A human-readable label for the loadable</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodlabel">uhu_loadable::label()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$loaded" id="$loaded"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$loaded</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">68</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> set to TRUE if a loadable has been loaded, FALSE otherwise</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload">uhu_loadable::load()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$loading" id="$loading"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$loading</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> set to FALSE while a loadable is loading, TRUE once it has finished loading.</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload">uhu_loadable::load()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$path" id="$path"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$path</span>
						(line <span class="line-number">52</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> The location of the loadable</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload">uhu_loadable::load()</a></li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodpath">uhu_loadable::path()</a></li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">builds an UHU Loadable</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../../UHU_exception/UHU_Loadable/uhu_loadable_exception.html">uhu_loadable_exception</a> - if the loadable $path_to_file doesn't exist, or if the $class_name is invalid.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">uhu_loadable</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$path_to_file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$class_name</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$interface</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$path_to_file</span><span class="var-description">: The location of the loadable</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$label</span><span class="var-description">: A human-readable label for the loadable</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class_name</span><span class="var-description">: the name of a class that will be found in the loadable</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$interface</span><span class="var-description">: TRUE if the loadable refers to an interface, FALSE if if the loadable refers to a class or abstract class</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclass_name" id="class_name"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">class_name</span> (line <span class="line-number">119</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$class_name">uhu_loadable::$class_name</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			class_name
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlabel" id="label"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">label</span> (line <span class="line-number">111</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/uhu.html#methodadd_loadable">uhu::add_loadable()</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$label">uhu_loadable::$label</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			label
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodload" id="load"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">load</span> (line <span class="line-number">142</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads the loadable, throwing an Exception upon failure</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#method__construct">uhu_loadable::__construct()</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/uhu.html#methodload_loadables">uhu::load_loadables()</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU_exception/UHU_Loadable/uhu_loadable_exception.html">uhu_loadable_exception</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload_cond">uhu_loadable::load_cond()</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$loading">uhu_loadable::$loading</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$class_name">uhu_loadable::$class_name</a></li>
				<li><span class="field">uses:</span> uhu_loadable::$inteface</li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$loaded">uhu_loadable::$loaded</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$path">uhu_loadable::$path</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			load
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodload_cond" id="load_cond"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">load_cond</span> (line <span class="line-number">127</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if the class/inteface exists, FALSE otherwise</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#methodload">uhu_loadable::load()</a></li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$interface">uhu_loadable::$interface</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			load_cond
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodpath" id="path"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">path</span> (line <span class="line-number">103</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../../UHU/UHU_Loadable/uhu_loadable.html#var$path">uhu_loadable::$path</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			path
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 13 Jan 2009 23:21:55 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>